currentFrame

Type

property

Summary

Specifies the current frame of an animated GIF.

Syntax

set the currentFrame of <image> to <frameNumber>

Description

Use the currentFrame property to check where an animated GIF image is in its sequence. Set this property in order to change the current frame of an animated GIF: for example, to examine the animation frame by frame.

If the image is not a GIF, the currentFrame property always reports 1, and setting it has no effect.

Examples

set the currentFrame of image "Process" to 1 -- back to the beginning

Value

Name	Type	Description
value		The currentFrame of an image is a positive integer. By default, the currentFrame property of newly created images is set to 1.

Related

glossary: frame, animated GIF, property

keyword: image, integer

object: image

property: repeatCount, frameCount, endFrame, startFrame, currentTime, palindromeFrames

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile